-
Notifications
You must be signed in to change notification settings - Fork 27.4k
docs(CONTRIBUTING): revert should be a valid type #12032
Conversation
Well, strictly, |
Can you describe it like that instead? |
Since there is only one "modifier", should I just say |
Also I'm maintaining the module conventional-changelog used by you guys. ## Bug Fixes
...
## Reverts
... |
Well at the moment, we are not actually using your package. Instead we use an script inside the angular.js project, The general idea, though, as far I am concerned, is that reverted commits should be removed from the changelog. So assuming that the original commit is also in the current release then we should simply ignore both commits. If it is reverting from a previous release, then I agree that we should have some kind of |
Yup, that script is actually the very first version of conventional-changelog. You guys should definitely use the package once I release Let me know what you think of the docs. |
@@ -192,7 +192,7 @@ Each commit message consists of a **header**, a **body** and a **footer**. The | |||
format that includes a **type**, a **scope** and a **subject**: | |||
|
|||
``` | |||
<type>(<scope>): <subject> | |||
(revert: )<type>(<scope>): <subject> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, the parentheses here on (revert: )
are because it is optional, right? But the parentheses on (<scope>)
are because they are needed in the string. Perhaps we should just not include the revert
bit in this and just explain about reverts as you do very clearly below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh right. I was thinking the scope is actually optional. Maybe we should note what's optional what's not?
Things I found about the commit message guide is that it's actually not very strict:
|
c7d18fa
to
b81d47f
Compare
This applies to the google doc you link to in the file. It gives more examples but still not very strict. |
I added two commits just to support my points (Maybe they should be in different PR but they kinda related and I need your opinions). Let me know what you think. Thanks. |
ping @petebacondarwin |
Fun fact: According to the |
hm... lol. for |
LGTM! |
Thanks @petebacondarwin , @gkalpak anything you would like to add here? |
Would be great if you guys could update the docs on google docs Or, even better, create a git repo just for the conventions? |
Thanks @petebacondarwin |
@stevemao I have also updated the google doc. |
Nice, will check it out |
EG: 462f444